home *** CD-ROM | disk | FTP | other *** search
/ 8bitfiles.net/archives / archives.tar / archives / compuserve-file-archive / 12 C64 Telecom / NOVA43.SFX / script files < prev    next >
Encoding:
Text File  |  1990-02-12  |  10.6 KB  |  359 lines
  1. 3.3  sCRIPT FILES
  2.  
  3. 3.3.1  dESCRIPTION.
  4.  
  5. sCRIPT FILES ARE PROGRAMS WHICH INSTRUCT nOVATERM TO PERFORM CERTAIN
  6. FUNCTIONS AUTOMATICALLY.  yOU FIRST CREATE A SCRIPT "PROGRAM" USING
  7. THE SCRIPT LANGUAGE, AND THEN YOU COMPILE THE PROGRAM INTO COMMAND
  8. CODES WHICH nOVATERM CAN INTERPRET AND EXECUTE.  aN EXAMPLE OF A
  9. SCRIPT IS A PROGRAM THAT CALLS UP A bbs, LOGS IN WITH YOUR NAME AND
  10. PASSWORD, READS NEW MESSAGES AND CAPTURES THEM IN THE BUFFER, LOGS
  11. OFF, AND SAVES THE MESSAGES TO DISK.
  12.  
  13. sCRIPT FILES ARE STORED ON DISK AS "USR" FILES, BUT THEY MUST BE
  14. LOADED INTO THE BUFFER IN ORDER TO BE EXECUTED.  nOVATERM READS
  15. TOKENIZED SCRIPT COMMANDS DIRECTLY FROM THE BUFFER AND EXECUTES THEM
  16. ONE AT A TIME.
  17.  
  18. 3.3.2  eXECUTING SCRIPT FILES.
  19.  
  20. tO START A SCRIPT FILE, SELECT "rUN SCRIPT FILE" FROM THE MAIN MENU.
  21. tYPE IN THE NAME OF THE SCRIPT FILE.  nOVATERM WILL CHECK THE BUFFER
  22. FOR THE FILE, AND IF IT IS NOT FOUND, nOVATERM WILL TRY TO LOAD THE
  23. SCRIPT FILE FROM DISK AND THEN EXECUTE IT.
  24.  
  25. 3.3.3  sTARTUP SCRIPT.
  26.  
  27. yOU CAN SPECIFY THE NAME OF A SCRIPT FILE WHICH WILL BE EXECUTED
  28. AUTOMATICALLY AFTER STARTING UP nOVATERM.  tO DO THIS, SELECT
  29. "tERMINAL PARAMS" FROM THE MAIN MENU, AND THEN SELECT "sTARTUP
  30. SCRIPT".  aFTER SPECIFYING A STARTUP SCRIPT FILE, YOU MUST ALSO SAVE
  31. THE CONFIGURATION (BY SELECTING "sAVE CONFIG FILE") SO THAT THE SCRIPT
  32. WILL BE EXECUTED THE NEXT TIME nOVATERM IS STARTED.
  33.  
  34. 3.3.4  cREATING SCRIPT FILES.
  35.  
  36. tO CREATE A SCRIPT FILE:
  37.  
  38. * sELECT "uTILITY PROGS" FROM THE MAIN MENU.
  39. * sELECT THE "tEXT EDITOR" PROGRAM.
  40. * uSE THE tEXT EDITOR TO WRITE THE SCRIPT PROGRAM.
  41. * wHILE STILL IN THE tEXT EDITOR, PRESS THE rUN-sTOP KEY TO COMPILE
  42.   THE SCRIPT.
  43. * tYPE IN A FILE NAME FOR THE OBJECT FILE, WHICH WILL BE THE
  44.   EXECUTABLE SCRIPT FILE.
  45.  
  46. iF YOU HAVE USED EARLIER VERSIONS OF nOVATERM, YOU MAY NOTICE THAT THE
  47. sCRIPT COMPILER PROGRAM IS NOT PRESENT IN VERSION 9.4.  tHIS MEANS IT
  48. IS NO LONGER POSSIBLE TO WRITE A SCRIPT PROGRAM DIRECTLY IN cOMMODORE
  49. basic MODE FOR COMPILATION.  iF YOU HAVE SCRIPT FILES IN THIS FORM
  50. FROM PREVIOUS VERSIONS THAT YOU WISH TO USE IN VERSION 9.4, YOU MAY
  51. STILL USE THE OLD sCRIPT COMPILER.  tHE OLD COMPILER WILL STILL
  52. PRODUCE EXECUTABLE SCRIPT FILES WHICH ARE COMPATIBLE WITH VERSION 9.4.
  53.  
  54. 3.3.5  sCRIPT COMMANDS.
  55.  
  56. cOMMANDS ARE GIVEN IN UPPERCASE.  hOWEVER, THE ACTUAL SCRIPT PROGRAMS
  57. SHOULD HAVE lowercase commands!  iF SCRIPT COMMANDS ARE TYPED IN
  58. UPPERCASE, they will not compile correctly.
  59.  
  60. eACH COMMAND SHOULD BE ENTERED ON A SEPARATE LINE; NO COLONS OR OTHER
  61. CHARACTERS ARE USED TO SEPARATE COMMANDS ON THE SAME LINE.  yOU MAY
  62. INCLUDE COMMENTS IN THE SCRIPT PROGRAM BY PLACING THE COMMENT TEXT
  63. AFTER A SEMICOLON (";") ON A LINE.  tHE COMPILER IGNORES ANYTHING
  64. WHICH APPEARS AFTER A SEMICOLON ON A GIVEN LINE.
  65.  
  66. aNY ARGUMENTS THAT GO ALONG WITH A COMMAND ARE PLACED NEXT TO IT.
  67. nUMERIC ARGUMENTS ARE GIVEN IN BRACKETS [ ], AND STRING ARGUMENTS ARE
  68. IN QUOTES " ".  oPTIONAL ARGUMENTS ARE GIVEN INSIDE GREATER-THAN AND
  69. LESS-THAN SYMBOLS.  tHE DESCRIPTION OF THE ARGUMENT IS IN LOWERCASE.
  70.  
  71. fOR COMMANDS WHICH LOAD MODULE FILES, OMIT THE PREFIX FROM THE FILE
  72. NAME.  (fOR EXAMPLE, prot"xmodem" WOULD WORK, BUT prot"prt.xmodem"
  73. WOULD NOT.)
  74.  
  75. iF YOU PLAN TO CREATE A SCRIPT FILE FOR USE IN ansi OR vt100 MODE, BE
  76. SURE TO REFER TO THE .opt COMMAND.
  77.  
  78. asc "ASCII TABLE"
  79.  
  80.    lOADS THE ascii TRANSLATION TABLE WITH THE GIVEN FILE NAME.
  81.  
  82. baud [BAUD RATE]
  83.  
  84.    cHANGES THE BAUD RATE TO THE SPECIFIED NUMBER.  iF THE BAUD RATE
  85.    GIVEN IS GREATER THAN THE MAXIMUM BAUD RATE FOR THE MODEM, NO
  86.    CHANGE IS MADE.
  87.  
  88. buffer COMMAND <"FILENAME">
  89.  
  90.    tHE FOLLOWING COMMANDS ARE AVAILABLE WITH buffer:
  91.  
  92.    clear - cLEARS ALL FILES FROM THE BUFFER.
  93.  
  94.    close - cLOSES A CAPTURE FILE.
  95.  
  96.    kill "FILENAME" - dELETES A FILE FROM THE BUFFER.
  97.  
  98.    load "FILENAME" - lOADS A FILE FROM DISK INTO THE BUFFER.
  99.  
  100.    open "FILENAME" - oPENS A CAPTURE FILE.
  101.  
  102.    print "FILENAME" - sENDS A BUFFER FILE TO THE PRINTER.
  103.  
  104.    save "FILENAME" - sAVES A FILE FROM THE BUFFER TO DISK.
  105.  
  106.    send "FILENAME" - sENDS A FILE FROM THE BUFFER TO THE MODEM.
  107.  
  108. check [STRING NUMBER] "STRING"
  109.  
  110.    wORKS IN CONJUNCTION WITH THE wait COMMAND TO DETECT INCOMING
  111.    STRINGS.  fOR EXAMPLE,
  112.  
  113.    check 2 "pASSWORD"
  114.  
  115.    DEFINES STRING NUMBER 2 AS "pASSWORD".  uP TO 6 STRINGS MAY BE
  116.    DEFINED.  wHEN THE SCRIPT ENCOUNTERS A wait COMMAND, IT GOES TO
  117.    TERMINAL MODE AND WAIT UNTIL ONE OF THESE DEFINED STRINGS IS
  118.    RECEIVED, AND THEN IT RETURNS THE RECEIVED STRING NUMBER.  sTRINGS
  119.    DEFINED WITH THE check COMMAND ARE CASE SENSITIVE, SO YOU MUST
  120.    INCLUDE CAPITAL LETTERS WHERE NECESSARY.
  121.  
  122. dial "ENTRY NAME"
  123.  
  124.    dIALS THE ENTRY WITH THE GIVEN NAME.  tHE AUTODIALER KEEPS
  125.    REDIALING UNTIL EITHER A CARRIER IS FOUND OR THE REDIAL COUNT IS
  126.    EXHAUSTED (SEE redial).
  127.  
  128. dial# "PHONE NUMBER"
  129.  
  130.    dIALS THE PHONE NUMBER SPECIFIED.
  131.  
  132. dialn [LOCATION IN PHONE LIST]
  133.  
  134.    dIALS THE ENTRY IN THE PHONE LIST CORRESPONDING TO THE SPECIFIED
  135.    NUMBER.  tHE NUMBERS DON'T SHOW UP ON THE AUTODIAL MENU, BUT, FOR
  136.    EXAMPLE, dialn 3 WOULD DIAL THE THIRD ENTRY FROM THE TOP.
  137.  
  138. disk [DEVICE NUMBER]
  139.  
  140.    cHANGES THE DISK DEVICE DEFAULT TO THE SPECIFIED DEVICE NUMBER. iF
  141.    THE DEVICE IS NOT PRESENT, THE SCRIPT HALTS WITH AN ERROR.
  142.  
  143. diskc "DISK COMMAND"
  144.  
  145.    sENDS THE SPECIFIED DISK COMMAND TO THE CURRENT DISK DEVICE.  tHE
  146.    EXTRA DISK COMMANDS ADDED BY nOVATERM ARE ALSO VALID.
  147.  
  148. download "FILENAME,TYPE"
  149.  
  150.    dOWNLOADS THE SPECIFIED FILE USING THE PROTOCOL IN MEMORY.  tHE
  151.    ONE-LETTER TYPE SPECIFICATION IS OPTIONAL.  iF USED, IT MUST BE
  152.    EITHER A "P", "S", OR "U" FOR PRG, SEQ, OR USR FILE TYPES,
  153.    RESPECTIVELY.  fOR BATCH PROTOCOLS, THE FILE NAME SPECIFIED HERE IS
  154.    IGNORED.
  155.  
  156. drive [DRIVE NUMBER]
  157.  
  158.    cHANGES THE DEFAULT DRIVE NUMBER (NOT DEVICE NUMBER).
  159.  
  160. end
  161.  
  162.    tERMINATES THE SCRIPT PROGRAM.
  163.  
  164. font "FONT FILE"
  165.  
  166.    lOADS A FONT FROM DISK.
  167.  
  168. font80 "FONT FILE"
  169.  
  170.    lOADS AN 80 COLUMN FONT FROM DISK.
  171.  
  172. gettime
  173.  
  174.    rEQUESTS THE USER TO INPUT THE CURRENT TIME.  iF YOUR SCRIPT
  175.    PROGRAM USES THE until COMMAND TO WAIT FOR A CERTAIN TIME OF DAY,
  176.    YOU SHOULD INCLUDE THIS COMMAND AT THE START OF YOUR PROGRAM SO
  177.    THAT YOU MAY SET THE CLOCK.
  178.  
  179. go40
  180.  
  181.    cHANGES TO 40 COLUMN MODE, IF THE TERMINAL EMULATOR ALLOWS IT.
  182.  
  183. go80
  184.  
  185.    cHANGES TO 80 COLUMN MODE.
  186.  
  187. hangup
  188.  
  189.    hANGS UP THE PHONE.
  190.  
  191. if <no> CONDITION then COMMAND
  192.  
  193.    uSED TO TEST VARIOUS CONDITIONS.  aNY ONE OF THE CONDITIONS BELOW
  194.    MAY BE SUBSTITUTED INTO THE COMMAND, AND IF THE CONDITION IS TRUE,
  195.    THE COMMAND AFTER then IS EXECUTED.  aNY COMMAND MAY BE PUT AFTER
  196.    then.
  197.  
  198.    carrier - cHECKS FOR A CARRIER.  iF no IS IN FRONT OF IT, THE
  199.    COMMAND EXECUTES IN THE ABSENCE OF A CARRIER.
  200.  
  201.    check [CHECK STRING] - cHECKS TO SEE IF THE SPECIFIED STRING NUMBER
  202.    WAS RECEIVED.  tHERE MUST BE A NUMBER AFTER check, OR THE COMMAND
  203.    IS INVALID.
  204.  
  205.    receive - cHECKS TO SEE IF DATA IS BEING RECEIVED.  iF no PRECEDES
  206.    IT, THE COMMAND EXECUTES WHEN DATA IS NOT BEING RECEIVED.
  207.  
  208.    ring - cHECKS TO SEE IF THE PHONE IS RINGING.  iF no PRECEDES IT,
  209.    THE COMMAND EXECUTES WHEN THE PHONE ISN'T RINGING.
  210.  
  211. jump LABEL
  212.  
  213.    jUMPS TO THE SPECIFIED LABEL IN THE PROGRAM.  lABELS ARE
  214.    NON-COMMAND WORDS WHICH ARE PLACED BEFORE COMMANDS TO IDENTIFY A
  215.    LOCATION IN THE PROGRAM.  fOR EXAMPLE:
  216.  
  217.     LOOP CHECK 1 "uSERNAME:"
  218.     .
  219.     .
  220.     JUMP LOOP
  221.  
  222.    aNOTHER EXAMPLE:
  223.  
  224.     LOOP IF NO CARRIER THEN JUMP LOOP
  225.  
  226.    lABELS MAY CONTAIN ANY CHARACTERS OTHER THAN QUOTES, BUT A LABEL
  227.    MAY ONLY BE ONE WORD.
  228.  
  229. link "SCRIPT PROGRAM"
  230.  
  231.    lOADS AND EXECUTES A NEW SCRIPT PROGRAM.
  232.  
  233. macro [FUNCTION KEY NUMBER]
  234.  
  235.    sENDS A FUNCTION KEY STRING.  tHIS IS EQUIVALENT TO PRESSING ONE OF
  236.    THE 16 FUNCTION KEYS.
  237.  
  238. minit
  239.  
  240.    iNITIALIZES THE MODEM IF NO CARRIER IS PRESENT.
  241.  
  242. modem "MODEM DRIVER"
  243.  
  244.    lOADS A MODEM DRIVER.
  245.  
  246. offhook
  247.  
  248.    tAKES THE PHONE OFF THE HOOK.
  249.  
  250. .opt PARAMETER
  251.  
  252.    cHANGES A COMPILER OPTION.  tHESE COMMANDS ARE NOT INCLUDED IN THE
  253.    PROGRAM WHEN IT IS COMPILED.  iNSTEAD, THEY DIRECT THE COMPILER TO
  254.    TAKE CERTAIN ACTIONS OR SET FLAGS.  tHE ONLY PARAMETERS CURRENTLY
  255.    SUPPORTED ARE:
  256.  
  257.    .OPT ANSI   : cONVERTS UPPERCASE CHARACTERS IN ALL FOLLOWING check
  258.                  STRINGS TO UPPERCASE CHARACTERS WITH LOWER ascii
  259.                  VALUES.  tHIS COMMAND IS NECESSARY IF THE SCRIPT
  260.                  IS GOING TO RUN IN ansi, vt52, OR vt100 MODE.
  261.    .OPT NOANSI : nO CONVERSION OF UPPERCASE CHARACTERS.  tHIS IS THE
  262.                  DEFAULT.
  263.  
  264. output "STRING"
  265.  
  266.    oUTPUTS A STRING TO THE MODEM.  cONTROL CHARACTERS ARE ENTERED AS
  267.    THEY ARE IN MACRO KEYS, WITH A ^ PRECEDING THE CORRESPONDING
  268.    LETTER.  fOR EXAMPLE, A CARRIAGE RETURN (CONTROL-m) WOULD BE
  269.    ENTERED AS ^m.
  270.  
  271. param "SETTING"
  272.  
  273.     cHANGES THE CURRENT COMMUNICATION PARAMETER SETTING.  vALID
  274.     ARGUMENTS FOR THE SETTING ARE:
  275.  
  276.     PARAM "8N1"  8 BITS, NO PARITY
  277.     PARAM "7E1"  7 BITS, EVEN PARITY
  278.     PARAM "7O1"  7 BITS, ODD PARITY
  279.  
  280. pause [NUMBER OF SECONDS]
  281.  
  282.    pAUSES THE PROGRAM FOR A SPECIFIED NUMBER OF SECONDS.
  283.  
  284. print "FILENAME"
  285.  
  286.    sENDS A FILE FROM DISK TO THE PRINTER.  iF THE PRINTER IS NOT
  287.    TURNED ON, THE SCRIPT ABORTS.
  288.  
  289. printer [DEVICE NUMBER]
  290.  
  291.    cHANGES THE PRINTER DEVICE DEFAULT TO THE SPECIFIED DEVICE NUMBER.
  292.    iF THE DEVICE IS NOT PRESENT, THE SCRIPT ABORTS WITH AN ERROR.
  293.  
  294. prot "PROTOCOL"
  295.  
  296.    lOADS A PROTOCOL.
  297.  
  298. redial [NUMBER OF TRIES]
  299.  
  300.    sETS THE NUMBER OF TIMES TO REDIAL A NUMBER BEFORE QUITTING.  iF A
  301.    NUMBER IS DIALED THIS MANY TIMES WITHOUT FINDING A CARRIER, THE
  302.    SCRIPT ABORTS.
  303.  
  304. screen "STRING"
  305.  
  306.    pRINTS A TEXT MESSAGE ON THE SCREEN.
  307.  
  308. secaddr [SECONDARY ADDRESS]
  309.  
  310.    cHANGES THE PRINTER SECONDARY ADDRESS.
  311.  
  312. send "FILENAME"
  313.  
  314.    sENDS A FILE TO THE MODEM.
  315.  
  316. term "TERMINAL EMULATOR"
  317.  
  318.    lOADS A TERMINAL EMULATOR.
  319.  
  320. uncheck [STRING NUMBER]
  321.  
  322.    cLEARS THE STRING IN THE SPECIFIED STRING NUMBER.  fOR EXAMPLE, IF
  323.    check 2 "pASSWORD" WAS PREVIOUSLY EXECUTED, uncheck 2 GETS RID OF
  324.    THAT DEFINITION FOR STRING NUMBER 2.
  325.  
  326. until "24-HOUR TIME"
  327.  
  328.    pAUSES EXECUTION OF THE SCRIPT.  tHE SCRIPT RESUMES WHEN THE TIME
  329.    OF DAY REACHES THE SPECIFIED TIME.  tHE TIME MUST BE IN 24-HOUR
  330.    FORM, AS SHOWN:
  331.  
  332.    UNTIL "hh:mm:ss"
  333.  
  334.    fOR EXAMPLE:
  335.  
  336.    UNTIL "22:35"  WAITS UNTIL 10:35 pm
  337.    UNTIL "11:50:25"  WAITS UNTIL 25 SECONDS PAST 11:50 am
  338.  
  339. upload "FILENAME"
  340.  
  341.    uPLOADS A FILE USING THE PROTOCOL IN MEMORY.
  342.  
  343. wait
  344.  
  345.    gOES INTO TERMINAL MODE AND RECEIVES DATA (AND PRINTS IT TO THE
  346.    SCREEN) WHILE WAITING FOR THE STRINGS SPECIFIED WITH THE check
  347.    COMMAND.  wHEN ONE OF THE STRINGS IS FOUND, IT STOPS WAITING AND
  348.    CONTINUES WITH THE SCRIPT.
  349.  
  350.    note:  iF A RECEIVED STRING PATTERN MATCHES MORE THAN ONE STRING
  351.    SPECIFIED BY check COMMANDS, THE LOWEST NUMBER IS RETURNED. fOR
  352.    EXAMPLE, IF STRING 1 IS ">" AND STRING 2 IS "lOBBY>", AND THE
  353.    STRING "lOBBY>" IS RECEIVED, THE SCRIPT RECOGNIZES STRING 1 BECAUSE
  354.    IT IS A LOWER STRING NUMBER, EVEN THOUGH BOTH STRINGS MATCH THE
  355.    RECEIVED DATA.
  356.  
  357.                                 ----
  358.  
  359.